<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2007 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.io;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.Beta;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.annotations.VisibleForTesting;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.Closeable;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.logging.Level;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.logging.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.annotation.Nullable;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Utility methods for working with {@link Closeable} objects.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @author Michael Lancaster<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @since 1.0<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>@Beta<a name="line.35"></a>
<span class="sourceLineNo">036</span>public final class Closeables {<a name="line.36"></a>
<span class="sourceLineNo">037</span>  @VisibleForTesting static final Logger logger<a name="line.37"></a>
<span class="sourceLineNo">038</span>      = Logger.getLogger(Closeables.class.getName());<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>  private Closeables() {}<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>  /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>   * Closes a {@link Closeable}, with control over whether an<a name="line.43"></a>
<span class="sourceLineNo">044</span>   * {@code IOException} may be thrown. This is primarily useful in a<a name="line.44"></a>
<span class="sourceLineNo">045</span>   * finally block, where a thrown exception needs to be logged but not<a name="line.45"></a>
<span class="sourceLineNo">046</span>   * propagated (otherwise the original exception will be lost).<a name="line.46"></a>
<span class="sourceLineNo">047</span>   *<a name="line.47"></a>
<span class="sourceLineNo">048</span>   * &lt;p&gt;If {@code swallowIOException} is true then we never throw<a name="line.48"></a>
<span class="sourceLineNo">049</span>   * {@code IOException} but merely log it.<a name="line.49"></a>
<span class="sourceLineNo">050</span>   *<a name="line.50"></a>
<span class="sourceLineNo">051</span>   * &lt;p&gt;Example: &lt;pre&gt;   {@code<a name="line.51"></a>
<span class="sourceLineNo">052</span>   *<a name="line.52"></a>
<span class="sourceLineNo">053</span>   *   public void useStreamNicely() throws IOException {<a name="line.53"></a>
<span class="sourceLineNo">054</span>   *     SomeStream stream = new SomeStream("foo");<a name="line.54"></a>
<span class="sourceLineNo">055</span>   *     boolean threw = true;<a name="line.55"></a>
<span class="sourceLineNo">056</span>   *     try {<a name="line.56"></a>
<span class="sourceLineNo">057</span>   *       // ... code which does something with the stream ...<a name="line.57"></a>
<span class="sourceLineNo">058</span>   *       threw = false;<a name="line.58"></a>
<span class="sourceLineNo">059</span>   *     } finally {<a name="line.59"></a>
<span class="sourceLineNo">060</span>   *       // If an exception occurs, rethrow it only if threw==false:<a name="line.60"></a>
<span class="sourceLineNo">061</span>   *       Closeables.close(stream, threw);<a name="line.61"></a>
<span class="sourceLineNo">062</span>   *     }<a name="line.62"></a>
<span class="sourceLineNo">063</span>   *   }}&lt;/pre&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span>   *<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * @param closeable the {@code Closeable} object to be closed, or null,<a name="line.65"></a>
<span class="sourceLineNo">066</span>   *     in which case this method does nothing<a name="line.66"></a>
<span class="sourceLineNo">067</span>   * @param swallowIOException if true, don't propagate IO exceptions<a name="line.67"></a>
<span class="sourceLineNo">068</span>   *     thrown by the {@code close} methods<a name="line.68"></a>
<span class="sourceLineNo">069</span>   * @throws IOException if {@code swallowIOException} is false and<a name="line.69"></a>
<span class="sourceLineNo">070</span>   *     {@code close} throws an {@code IOException}.<a name="line.70"></a>
<span class="sourceLineNo">071</span>   */<a name="line.71"></a>
<span class="sourceLineNo">072</span>  public static void close(@Nullable Closeable closeable,<a name="line.72"></a>
<span class="sourceLineNo">073</span>      boolean swallowIOException) throws IOException {<a name="line.73"></a>
<span class="sourceLineNo">074</span>    if (closeable == null) {<a name="line.74"></a>
<span class="sourceLineNo">075</span>      return;<a name="line.75"></a>
<span class="sourceLineNo">076</span>    }<a name="line.76"></a>
<span class="sourceLineNo">077</span>    try {<a name="line.77"></a>
<span class="sourceLineNo">078</span>      closeable.close();<a name="line.78"></a>
<span class="sourceLineNo">079</span>    } catch (IOException e) {<a name="line.79"></a>
<span class="sourceLineNo">080</span>      if (swallowIOException) {<a name="line.80"></a>
<span class="sourceLineNo">081</span>        logger.log(Level.WARNING,<a name="line.81"></a>
<span class="sourceLineNo">082</span>            "IOException thrown while closing Closeable.", e);<a name="line.82"></a>
<span class="sourceLineNo">083</span>      } else {<a name="line.83"></a>
<span class="sourceLineNo">084</span>        throw e;<a name="line.84"></a>
<span class="sourceLineNo">085</span>      }<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span>  }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>  /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>   * Equivalent to calling {@code close(closeable, true)}, but with no<a name="line.90"></a>
<span class="sourceLineNo">091</span>   * IOException in the signature.<a name="line.91"></a>
<span class="sourceLineNo">092</span>   * @param closeable the {@code Closeable} object to be closed, or null, in<a name="line.92"></a>
<span class="sourceLineNo">093</span>   *      which case this method does nothing<a name="line.93"></a>
<span class="sourceLineNo">094</span>   * @deprecated This method has few valid use cases and encourages misuse by<a name="line.94"></a>
<span class="sourceLineNo">095</span>   *     making it easy to do the wrong thing. Among other things, it may<a name="line.95"></a>
<span class="sourceLineNo">096</span>   *     swallow exceptions that really should be thrown, such as exceptions<a name="line.96"></a>
<span class="sourceLineNo">097</span>   *     thrown when closing an output stream: this often involves flushing<a name="line.97"></a>
<span class="sourceLineNo">098</span>   *     buffered data to the final output destination and as such it is just<a name="line.98"></a>
<span class="sourceLineNo">099</span>   *     as important to throw the exception thrown when closing as it is to<a name="line.99"></a>
<span class="sourceLineNo">100</span>   *     throw an exception thrown by a call to a write method. This method<a name="line.100"></a>
<span class="sourceLineNo">101</span>   *     is scheduled to be removed in Guava 16.0.<a name="line.101"></a>
<span class="sourceLineNo">102</span>   */<a name="line.102"></a>
<span class="sourceLineNo">103</span>  @Deprecated<a name="line.103"></a>
<span class="sourceLineNo">104</span>  public static void closeQuietly(@Nullable Closeable closeable) {<a name="line.104"></a>
<span class="sourceLineNo">105</span>    try {<a name="line.105"></a>
<span class="sourceLineNo">106</span>      close(closeable, true);<a name="line.106"></a>
<span class="sourceLineNo">107</span>    } catch (IOException e) {<a name="line.107"></a>
<span class="sourceLineNo">108</span>      logger.log(Level.SEVERE, "IOException should not have been thrown.", e);<a name="line.108"></a>
<span class="sourceLineNo">109</span>    }<a name="line.109"></a>
<span class="sourceLineNo">110</span>  }<a name="line.110"></a>
<span class="sourceLineNo">111</span>}<a name="line.111"></a>




























































</pre>
</div>
</body>
</html>
